Upload a GeoTIFF

All models in the FMSF require a GeoTIFF to characterize fuels and/or vegetation. Currently the FMSF ONLY supports GeoTIFFs from the LANDFIRE Product Service (LFPS).

Rules for the GeoTIFF file:

The GeoTIFF must be in a zipped folder (*.zip)
The zipped folder can only contain a single GeoTIFF
The zipped folder must contain a *.tif and *.tif.aux.xml files
The GeoTIFF cannot be further nested into other folders within the zipped folder

After requesting and downloading a GeoTIFF from the LFPS it will need to be uploaded to the FMSF prior to running a model. The ID assigned will be used to Run a Model. See the Model Input Details section for the GeoTIFF requirements for each model.

API Endpoint

POST /model/landscapeUpload

Example Request

curl -X POST "https://fmsf.firenet.gov/fmsfModelREST/model/landscapeUpload" -H "accept: text/plain" -H "Authorization: Basic <basic64 encoded username:API key>" -H "Content-Type: multipart/form-data" -F "Landscape File=@<GeoTIFF zip>;type=application/x-zip-compressed"

Example Response

{"success":true,"queued":false,"includesWarningOrInfo":false,"multipleResponseMsgs":false,"msgCollector":null,"responseMessage":"Request to upload the landscape/layers file <GeoTIFF zip> was completed - ID is <GeoTIFF ID>","entityId":<GeoTIFF ID>}

Request Body

Name	Type	Required	Description
Authorization	String	Required	<Basic64 encoded username:API key> credentials of the User
GeoTIFF Zip	String	Required	<GeoTIFF Name> zip folder name that contains the GeoTIFF and metadata

Response Fields

Code 200 - OK

Name	Type	Description
success	Boolean	Upload completion status
queued	Boolean	Upload queued status
includesWarningOrInfo	Boolean	Not used; will be deprecated
multipleResponseMsgs	Boolean	Not used; will be deprecated
msgCollector	String	Not used; will be deprecated
responseMessage	String	Descriptive explanation what occurred during the request
entityId	Integer	FMSF assigned <GeoTIFF ID> for the uploaded GeoTIFF

Code 400 – The request was unacceptable

Invalid GeoTIFF file path provided

Code 401 – Unauthorized

Authorization info is missing or invalid

Code 500 – Server errors

Something went wrong on the FMSF end. Server error handling the request